<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OSBLEPlus.Services</name>
    </assembly>
    <members>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.ApiDescriptionExtensions.GetFriendlyId(System.Web.Http.Description.ApiDescription)">
            <summary>
            Generates an URI-friendly ID for the <see cref="T:System.Web.Http.Description.ApiDescription"/>. E.g. "Get-Values-id_name" instead of "GetValues/{id}?name={name}"
            </summary>
            <param name="description">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <returns>The ID as a string.</returns>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfig">
            <summary>
            Use this class to customize the Help Page.
            For example you can set a custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation
            or you can provide the samples for the requests/responses.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.Controllers.APIHelpController">
            <summary>
            The controller that will handle requests for the help page.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetDocumentationProvider(System.Web.Http.HttpConfiguration,System.Web.Http.Description.IDocumentationProvider)">
            <summary>
            Sets the documentation provider for help page.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="documentationProvider">The documentation provider.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleObjects(System.Web.Http.HttpConfiguration,System.Collections.Generic.IDictionary{System.Type,System.Object})">
            <summary>
            Sets the objects that will be used by the formatters to produce sample requests/responses.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sampleObjects">The sample objects.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
            <summary>
            Sets the sample request directly for the specified media type and action.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample request.</param>
            <param name="mediaType">The media type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
            <summary>
            Sets the sample request directly for the specified media type and action with parameters.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample request.</param>
            <param name="mediaType">The media type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
            <summary>
            Sets the sample request directly for the specified media type of the action.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample response.</param>
            <param name="mediaType">The media type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
            <summary>
            Sets the sample response directly for the specified media type of the action with specific parameters.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample response.</param>
            <param name="mediaType">The media type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForMediaType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue)">
            <summary>
            Sets the sample directly for all actions with the specified media type.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample.</param>
            <param name="mediaType">The media type.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
            <summary>
            Sets the sample directly for all actions with the specified type and media type.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sample">The sample.</param>
            <param name="mediaType">The media type.</param>
            <param name="type">The parameter type or return type of an action.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
            <summary>
            Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
            The help page will use this information to produce more accurate request samples.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="type">The type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
            <summary>
            Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
            The help page will use this information to produce more accurate request samples.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="type">The type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
            <summary>
            Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
            The help page will use this information to produce more accurate response samples.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="type">The type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
            <summary>
            Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
            The help page will use this information to produce more accurate response samples.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="type">The type.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration)">
            <summary>
            Gets the help page sample generator.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <returns>The help page sample generator.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.SetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration,OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator)">
            <summary>
            Sets the help page sample generator.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="sampleGenerator">The help page sample generator.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.GetModelDescriptionGenerator(System.Web.Http.HttpConfiguration)">
            <summary>
            Gets the model description generator.
            </summary>
            <param name="config">The configuration.</param>
            <returns>The <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator"/></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageApiModel(System.Web.Http.HttpConfiguration,System.String)">
            <summary>
            Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.
            </summary>
            <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
            <param name="apiDescriptionId">The <see cref="T:System.Web.Http.Description.ApiDescription"/> ID.</param>
            <returns>
            An <see cref="T:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel"/>
            </returns>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescription">
            <summary>
            Describes a type model.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator">
            <summary>
            Generates model descriptions for given types.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelNameAttribute">
            <summary>
            Use this attribute to change the name of the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescription"/> generated for a type.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel">
            <summary>
            The model that represents an API displayed on the help page.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel"/> class.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription">
            <summary>
            Gets or sets the <see cref="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription"/> that describes the API.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.UriParameters">
            <summary>
            Gets or sets the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ParameterDescription"/> collection that describes the URI parameters for the API.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.RequestDocumentation">
            <summary>
            Gets or sets the documentation for the request.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.RequestModelDescription">
            <summary>
            Gets or sets the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the request body.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.RequestBodyParameters">
            <summary>
            Gets the request body parameter descriptions.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.ResourceDescription">
            <summary>
            Gets or sets the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the resource.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.ResourceProperties">
            <summary>
            Gets the resource property descriptions.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.SampleRequests">
            <summary>
            Gets the sample requests associated with the API.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.SampleResponses">
            <summary>
            Gets the sample responses associated with the API.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.Models.HelpPageApiModel.ErrorMessages">
            <summary>
            Gets the error messages associated with this model.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator">
            <summary>
            This class will generate the samples for the help page.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator"/> class.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.GetSampleRequests(System.Web.Http.Description.ApiDescription)">
            <summary>
            Gets the request body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
            </summary>
            <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <returns>The samples keyed by media type.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.GetSampleResponses(System.Web.Http.Description.ApiDescription)">
            <summary>
            Gets the response body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
            </summary>
            <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <returns>The samples keyed by media type.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.GetSample(System.Web.Http.Description.ApiDescription,OSBLEPlus.Services.Areas.HelpPage.SampleDirection)">
            <summary>
            Gets the request or response body samples.
            </summary>
            <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
            <returns>The samples keyed by media type.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.GetActionSample(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Type,System.Net.Http.Formatting.MediaTypeFormatter,System.Net.Http.Headers.MediaTypeHeaderValue,OSBLEPlus.Services.Areas.HelpPage.SampleDirection)">
            <summary>
            Search for samples that are provided directly through <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples"/>.
            </summary>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
            <param name="type">The CLR type.</param>
            <param name="formatter">The formatter.</param>
            <param name="mediaType">The media type.</param>
            <param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
            <returns>The sample that matches the parameters.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.GetSampleObject(System.Type)">
            <summary>
            Gets the sample object that will be serialized by the formatters. 
            First, it will look at the <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects"/>. If no sample object is found, it will try to create
            one using <see cref="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.DefaultSampleObjectFactory(OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator,System.Type)"/> (which wraps an <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ObjectGenerator"/>) and other
            factories in <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories"/>.
            </summary>
            <param name="type">The type.</param>
            <returns>The sample object.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.ResolveHttpRequestMessageType(System.Web.Http.Description.ApiDescription)">
            <summary>
            Resolves the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
            </summary>
            <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <returns>The type.</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.ResolveType(System.Web.Http.Description.ApiDescription,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},OSBLEPlus.Services.Areas.HelpPage.SampleDirection,System.Collections.ObjectModel.Collection{System.Net.Http.Formatting.MediaTypeFormatter}@)">
            <summary>
            Resolves the type of the action parameter or return value when <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/> is used.
            </summary>
            <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
            <param name="sampleDirection">The value indicating whether the sample is for a request or a response.</param>
            <param name="formatters">The formatters.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.WriteSampleObjectUsingFormatter(System.Net.Http.Formatting.MediaTypeFormatter,System.Object,System.Type,System.Net.Http.Headers.MediaTypeHeaderValue)">
            <summary>
            Writes the sample object using formatter.
            </summary>
            <param name="formatter">The formatter.</param>
            <param name="value">The value.</param>
            <param name="type">The type.</param>
            <param name="mediaType">Type of the media.</param>
            <returns></returns>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.ActualHttpMessageTypes">
            <summary>
            Gets CLR types that are used as the content of <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/>.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples">
            <summary>
            Gets the objects that are used directly as samples for certain actions.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects">
            <summary>
            Gets the objects that are serialized as samples by the supported formatters.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories">
            <summary>
            Gets factories for the objects that the supported formatters will serialize as samples. Processed in order,
            stopping when the factory successfully returns a non-<see langref="null"/> object.
            </summary>
            <remarks>
            Collection includes just <see cref="M:OSBLEPlus.Services.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)"/> initially. Use
            <code>SampleObjectFactories.Insert(0, func)</code> to provide an override and
            <code>SampleObjectFactories.Add(func)</code> to provide a fallback.</remarks>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey">
            <summary>
            This is used to identify the place where the sample should be applied.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue)">
            <summary>
            Creates a new <see cref="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey"/> based on media type.
            </summary>
            <param name="mediaType">The media type.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
            <summary>
            Creates a new <see cref="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey"/> based on media type and CLR type.
            </summary>
            <param name="mediaType">The media type.</param>
            <param name="type">The CLR type.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.#ctor(OSBLEPlus.Services.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
            <summary>
            Creates a new <see cref="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey"/> based on <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
            </summary>
            <param name="sampleDirection">The <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,OSBLEPlus.Services.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
            <summary>
            Creates a new <see cref="T:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey"/> based on media type, <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
            </summary>
            <param name="mediaType">The media type.</param>
            <param name="sampleDirection">The <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
            <param name="controllerName">Name of the controller.</param>
            <param name="actionName">Name of the action.</param>
            <param name="parameterNames">The parameter names.</param>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.ControllerName">
            <summary>
            Gets the name of the controller.
            </summary>
            <value>
            The name of the controller.
            </value>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.ActionName">
            <summary>
            Gets the name of the action.
            </summary>
            <value>
            The name of the action.
            </value>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.MediaType">
            <summary>
            Gets the media type.
            </summary>
            <value>
            The media type.
            </value>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.ParameterNames">
            <summary>
            Gets the parameter names.
            </summary>
        </member>
        <member name="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection">
            <summary>
            Gets the <see cref="P:OSBLEPlus.Services.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.ImageSample">
            <summary>
            This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.ImageSample.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.ImageSample"/> class.
            </summary>
            <param name="src">The URL of an image.</param>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.InvalidSample">
            <summary>
            This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.ObjectGenerator">
            <summary>
            This class will create an object of a given type and populate it with sample data.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)">
            <summary>
            Generates an object for a given type. The type needs to be public, have a public default constructor and settable public properties/fields. Currently it supports the following types:
            Simple types: <see cref="T:System.Int32"/>, <see cref="T:System.String"/>, <see cref="T:System.Enum"/>, <see cref="T:System.DateTime"/>, <see cref="T:System.Uri"/>, etc.
            Complex types: POCO types.
            Nullables: <see cref="T:System.Nullable`1"/>.
            Arrays: arrays of simple types or complex types.
            Key value pairs: <see cref="T:System.Collections.Generic.KeyValuePair`2"/>
            Tuples: <see cref="T:System.Tuple`1"/>, <see cref="T:System.Tuple`2"/>, etc
            Dictionaries: <see cref="T:System.Collections.Generic.IDictionary`2"/> or anything deriving from <see cref="T:System.Collections.Generic.IDictionary`2"/>.
            Collections: <see cref="T:System.Collections.Generic.IList`1"/>, <see cref="T:System.Collections.Generic.IEnumerable`1"/>, <see cref="T:System.Collections.Generic.ICollection`1"/>, <see cref="T:System.Collections.IList"/>, <see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> or anything deriving from <see cref="T:System.Collections.Generic.ICollection`1"/> or <see cref="T:System.Collections.IList"/>.
            Queryables: <see cref="T:System.Linq.IQueryable"/>, <see cref="T:System.Linq.IQueryable`1"/>.
            </summary>
            <param name="type">The type.</param>
            <returns>An object of the given type.</returns>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.SampleDirection">
            <summary>
            Indicates whether the sample is used for request or response
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.TextSample">
            <summary>
            This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
            </summary>
        </member>
        <member name="T:OSBLEPlus.Services.Areas.HelpPage.XmlDocumentationProvider">
            <summary>
            A custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> that reads the API documentation from an XML documentation file.
            </summary>
        </member>
        <member name="M:OSBLEPlus.Services.Areas.HelpPage.XmlDocumentationProvider.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:OSBLEPlus.Services.Areas.HelpPage.XmlDocumentationProvider"/> class.
            </summary>
            <param name="documentPath">The physical path to XML document.</param>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CommunityController.CommunityEnabled">
            <summary>
            Returns the Assembly's Library Version Number as a string
            </summary>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.AssemblyInfoController.VersionNumber">
            <summary>
            Returns the Assembly's Library Version Number as a string
            </summary>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CalendarDayController.Get(OSBLEPlus.Logic.DomainObjects.Analytics.CalendarAttributes)">
            <summary>
            Gets the Hourly Aggregates from the Calendar
            </summary>
            <param name="attr">
            attr has the following POCO format
            public DateTime ReferenceDate { get; set; }
            public AggregateFunction AggregateFunctionId { get; set; }
            public int? CourseId { get; set; }
            public string SelectedMeasures { get; set; }
            public string SubjectUsers { get; set; }
            </param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CalendarController.Get(OSBLEPlus.Logic.DomainObjects.Analytics.CalendarAttributes)">
            <summary>
            Takes a CalendarAttributes class, returns the Daily Aggregation from the calendar
            </summary>
            <param name="attr">
            attr has the following POCO format
            public DateTime ReferenceDate { get; set; }
            public AggregateFunction AggregateFunctionId { get; set; }
            public int? CourseId { get; set; }
            public string SelectedMeasures { get; set; }
            public string SubjectUsers { get; set; }
            </param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CourseController.MostRecentWhatsNewItem">
            <summary>
            Returns the DateTime of the most recent item
            </summary>
            <returns>DateTime</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CourseController.GetAssignmentsForCourse(System.Int32,System.String)">
            <summary>
            Returns a list of Submission assignments
            </summary>
            <param name="id">Course ID for the class</param>
            <param name="a">Authentication Key for the Course to access the assignment</param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CourseController.GetLastSubmitDateForAssignment(System.Int32,System.String)">
            <summary>
            Get's the last submit date for an assignment
            </summary>
            <param name="id">Course ID for the class</param>
            <param name="a">Authentication Key for the Course to access the assignment</param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.CourseController.Post(OSBLEPlus.Logic.DomainObjects.ActivityFeeds.SubmissionRequest)">
            <summary>
            Post submits and assignment
            </summary>
            <param name="request">
            request has the following POCO Format:
            public string AuthToken { get; set; }
            public SubmitEvent SubmitEvent { get; set; }
            </param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.EventCollectionController.Echo(System.String)">
            <summary>
            Echos back the sent string.
            </summary>
            <param name="toEcho">string to return</param>
            <returns>returns toEcho</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.EventCollectionController.Post(OSBLEPlus.Logic.DomainObjects.ActivityFeeds.EventPostRequest)">
            <summary>
            Posts any Event sent via the EventPostRequest type
            </summary>
            <param name="request">
            request has the following POCO format
            public AskForHelpEvent AskHelpEvent { get; set; }
            public BuildEvent BuildEvent { get; set; }
            public CutCopyPasteEvent CutCopyPasteEvent { get; set; }
            public DebugEvent DebugEvent { get; set; }
            public EditorActivityEvent EditorActivityEvent { get; set; }
            public ExceptionEvent ExceptionEvent { get; set; }
            public FeedPostEvent FeedPostEvent { get; set; }
            public HelpfulMarkGivenEvent HelpfulMarkEvent { get; set; }
            public LogCommentEvent LogCommentEvent { get; set; }
            public SaveEvent SaveEvent { get; set; }
            public SubmitEvent SubmitEvent { get; set; }
            </param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.EventCollectionControllerHelper.GetActivityEvent(OSBLEPlus.Logic.DomainObjects.ActivityFeeds.EventPostRequest)">
            <summary>
            Finds the first non-null Event in an EventPostRequest and returns that
            </summary>
            <param name="requestObject">
            requestObject has the following POCO format
            public AskForHelpEvent AskHelpEvent { get; set; }
            public BuildEvent BuildEvent { get; set; }
            public CutCopyPasteEvent CutCopyPasteEvent { get; set; }
            public DebugEvent DebugEvent { get; set; }
            public EditorActivityEvent EditorActivityEvent { get; set; }
            public ExceptionEvent ExceptionEvent { get; set; }
            public FeedPostEvent FeedPostEvent { get; set; }
            public HelpfulMarkGivenEvent HelpfulMarkEvent { get; set; }
            public LogCommentEvent LogCommentEvent { get; set; }
            public SaveEvent SaveEvent { get; set; }
            public SubmitEvent SubmitEvent { get; set; }
            </param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.FeedController.Get(System.DateTime,System.DateTime,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32})">
            <summary>
            Queries the database for items to return to place in an Activity Feed.
            </summary>
            <param name="dmin">Minimum DateTime</param>
            <param name="dmax">Maximum DateTime</param>
            <param name="lmin">Minimum EventLogId</param>
            <param name="lmax">Maximum EventLogId</param>
            <param name="ls">IEnumerable of Specific LogIDs</param>
            <param name="ets">IEnumerable of Event Types</param>
            <param name="c">Course Id</param>
            <param name="r">Role Id</param>
            <param name="cf">Comment Filter (looks for a string at contains this item)</param>
            <param name="us">Sender Ids</param>
            <param name="topN">Max amount of posts to return</param>
            <returns>IEnumerable of FeedItem</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.InterventionController.AnalyzeBuildErrorHistory(System.Int32,OSBLEPlus.Logic.DomainObjects.ActivityFeeds.BuildEvent)">
            <summary>
            Checks the build intervention criteria.
            1. build failure count  > BuildErrorThreshold within the last NumberOfMinutes
            2. No build failure interventin within the last NumberOfMinutes
            3. If build failure within last NumberOfMinutes, dismiss last intervention, create new with most up to date data
            </summary>
            <param name="userProfileId"></param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.InterventionController.InterventionRequiresRefresh(OSBLE.Models.Intervention.InterventionItem)">
            <summary>
            Checks to see if a type of intervention needs the 'latest' data and should be refreshed if one already exists.
            returning true means the intervention needs to be dismissed and generated again (e.g. it's a build error and there may be new/different errors)
            returning false means do not dismiss or generate another intervention, leave the one that is still live up.
            </summary>
            <param name="existingIntervention"></param>
            <returns></returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.InterventionController.UpdateClassmatesAvailable(System.Int32)">
            <summary>
            Checks if other users are offering help in any of this user's courses... if so, generate the others offering help intervention
            </summary>
            <param name="userProfileId"></param>
        </member>
        <!-- Badly formed XML comment ignored for member "M:OSBLEPlus.Services.Controllers.TimelineController.Get(OSBLEPlus.Logic.DomainObjects.Analytics.TimelineCriteria)" -->
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.Login(OSBLEPlus.Logic.DomainObjects.Profiles.APILogin)">
            <summary>
            Logs the user in with the passed username and hashed password
            </summary>
            <param name="e">Username</param>
            <param name="hp">Hashed Password</param>
            <returns>HttpResponeMessage</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.GetActiveUser(System.String)">
            <summary>
            Get's the active user from an authentication key
            </summary>
            <param name="a">Authentication Key</param>
            <returns>IUser which has the following POCO format
             int IUserId { get; set; }
            string Email { get; set; }
            string FirstName { get; set; }
            string LastName { get; set; }
            string FullName { get; }
            int ISchoolId { get; set; }
            string Identification { get; set; }
            bool IsAdmin { get; set; }
            bool EmailAllActivityPosts { get; set; }
            bool EmailSelfActivityPosts { get; set; }
            bool EmailAllNotifications { get; set; }
            bool EmailNewDiscussionPosts { get; set; }
            int IDefaultCourseId { get; set; }
            ICourse DefalutCourse { get; set; }
            string DisplayName(CourseUser viewingUser);
            </returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.IsValidKey(System.String)">
            <summary>
            Checks if the Authentication Key passed in is valid
            </summary>
            <param name="a">Authentication Key</param>
            <returns>bool</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.GetCoursesForUser(System.String)">
            <summary>
            Gets the Courses the User is associated with in the database
            </summary>
            <param name="a">Authentication Key</param>
            <returns>List of ProfileCourse which has the following POCO format
            public int Id { get; set; }
            public int Number { get; set; }
            public string NamePrefix { get; set; }
            public string Description { get; set; }
            public string Name { get; set; }
            public string Semester { get; set; }
            public int Year { get; set; }
            public DateTime StartDate { get; set; }
            public DateTime EndDate { get; set; }
            </returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.MostRecentSocialActivity(System.String)">
            <summary>
            Gets the most recent Social Activity
            </summary>
            <param name="a">Authentication Key</param>
            <returns>DateTime value</returns>
        </member>
        <member name="M:OSBLEPlus.Services.Controllers.UserProfilesController.SubmitLocalErrorLog(OSBLEPlus.Logic.DomainObjects.Helpers.LocalErrorLogRequest)">
            <summary>
            Submits an error log from the local user's machine
            </summary>
            <param name="request">
            request is a LocalerrorLogRequest that has the following POCO format
            public string AuthToken { get; set; }
            public LocalErrorLog Log { get; set; }
            </param>
            <returns></returns>
        </member>
    </members>
</doc>
